コードコメントには Why not
コードには How
テストコードには What
コミットログには Why
コードコメントには Why not
を書こうという話をした
t-wada さんの超便利ツイート。あらためてページに起こしてメモしておく。 HWWWn （はわわわん）の原則
ぼくはこの中で、タイトルにもした「Why not」の説明がいちばん好き。Why not ってだいたいコードレビューでコメントが入りがちで「素直に設計したら◯◯になると思うんですけど、なぜそうしなかったのですか？」と聞きたくなるところに気の利いた Why not が置いてあると、やりとりが一往復へって最高に捗る感じがするからです。 この「一往復を節約する」ってのは共同作業全般においてぼくが重視したいことなんだろうなあ。これの積み重ねでタスク完了までに要する時間が大きく変わってくる、という感覚がある。